home *** CD-ROM | disk | FTP | other *** search
/ Deutsche Edition 1 / Deutsche Edition 1.iso / amok / 071-080 / amok73 / ums / doc / ums.h < prev   
C/C++ Source or Header  |  1993-11-04  |  12KB  |  265 lines

  1. #ifndef UMS_H
  2. #define UMS_H
  3.  
  4. /*
  5.  * libraries/ums.h
  6.  *
  7.  * C definitions for ums.library (V9)
  8.  *
  9.  */
  10.  
  11. #ifndef EXEC_TYPES_H
  12. #include <exec/types.h>
  13. #endif
  14.  
  15. #ifndef UTILITY_TAGITEM_H
  16. #include <utility/tagitem.h>
  17. #endif
  18.  
  19. #define UMSNAME    "ums.library"
  20. #define UMSVERSION 9
  21.  
  22. /* typedefs */
  23. typedef char    **OldUMSMsg;      /* OBSOLETE!! OBSOLETE!! OBSOLETE!! */
  24.  
  25. typedef void     *UMSUserAccount; /* UMS user account   */
  26. typedef LONG      UMSMsgNum;      /* UMS message number */
  27. typedef WORD      UMSError;       /* UMS error number   */
  28. typedef LONGBITS  UMSSet;         /* UMS bit set        */
  29. typedef APTR      UMSPHandle;     /* UMS pattern handle */
  30.  
  31. #define UMSMAXMSGS 2147483647  /* LONG --> 2^31-1    */
  32.  
  33. /* message array index definitions (see UMS Doc #3) */
  34. #define UMSCODE_MsgText       0
  35. #define UMSCODE_FromName      1
  36. #define UMSCODE_FromPath      2
  37. #define UMSCODE_ToName        3
  38. #define UMSCODE_ToPath        4
  39. #define UMSCODE_MsgID         5
  40. #define UMSCODE_CreationDate  6
  41. #define UMSCODE_ReceiveDate   7
  42. #define UMSCODE_ReferID       8
  43. #define UMSCODE_Group         9
  44. #define UMSCODE_Subject      10
  45. #define UMSCODE_Attributes   11
  46. #define UMSCODE_Comments     12
  47. #define UMSCODE_Organization 13
  48. #define UMSCODE_Distribution 14
  49. #define UMSNUMFIELDS         128
  50.  
  51. /* message data types */
  52. typedef char *UMSMsgTextFields[UMSNUMFIELDS];
  53. struct MessageInfo {
  54.                     LONG      msgi_HeaderLength;
  55.                     LONG      msgi_TextLength;
  56.                     LONG      msgi_Date;
  57.                     UMSMsgNum msgi_ChainUp;
  58.                     UMSMsgNum msgi_ChainDn;
  59.                     UMSMsgNum msgi_ChainLt;
  60.                     UMSMsgNum msgi_ChainRt;
  61.                     UMSSet    msgi_GlobalStatus;
  62.                     UMSSet    msgi_UserStatus;
  63.                     UMSSet    msgi_LoginStatus;
  64.                     UMSMsgNum msgi_HardLink;
  65.                     UMSMsgNum msgi_SoftLink;
  66.                    };
  67.  
  68. /* user status bits */
  69. #define UMSUSTATB_Archive      4
  70. #define UMSUSTATF_Archive     (1L<<4)
  71. #define UMSUSTATB_Junk         5
  72. #define UMSUSTATF_Junk        (1L<<5)
  73. #define UMSUSTATB_PostPoned    6
  74. #define UMSUSTATF_PostPoned   (1L<<6)
  75. #define UMSUSTATB_Selected     7
  76. #define UMSUSTATF_Selected    (1L<<7)
  77. #define UMSUSTATB_Old          8
  78. #define UMSUSTATF_Old         (1L<<8)
  79. #define UMSUSTATB_Read        UMSUSTATB_Old
  80. #define UMSUSTATF_Read        UMSUSTATF_Old
  81. #define UMSUSTATB_WriteAccess  9
  82. #define UMSUSTATF_WriteAccess (1L<<9)
  83. #define UMSUSTATB_ReadAccess  10
  84. #define UMSUSTATF_ReadAccess  (1L<<10)
  85. #define UMSUSTATB_ViewAccess  11
  86. #define UMSUSTATF_ViewAccess  (1L<<11)
  87. #define UMSUSTATB_Owner       12
  88. #define UMSUSTATF_Owner       (1L<<12)
  89.  
  90. #define UMSUSTATF_Protected   (UMSUSTATF_WriteAccess | UMSUSTATF_ReadAccess | UMSUSTATF_ViewAccess | UMSUSTATF_Owner)
  91.  
  92. /* global status bits */
  93. #define UMSGSTATB_Deleted      0
  94. #define UMSGSTATF_Deleted     (1L<<0)
  95. #define UMSGSTATB_Expired      1
  96. #define UMSGSTATF_Expired     (1L<<1)
  97. #define UMSGSTATB_Exported     2
  98. #define UMSGSTATF_Exported    (1L<<2)
  99. #define UMSGSTATB_Orphan       3
  100. #define UMSGSTATF_Orphan      (1L<<3)
  101. #define UMSGSTATB_Link         4
  102. #define UMSGSTATF_Link        (1L<<4)
  103. #define UMSGSTATB_HardLink     5
  104. #define UMSGSTATF_HardLink    (1L<<5)
  105.  
  106. #define UMSGSTATF_Protected   (UMSGSTATF_Deleted | UMSGSTATF_Exported | UMSGSTATF_Orphan | UMSGSTATF_Link | UMSGSTATF_HardLink)
  107.  
  108. /* UMS error numbers */
  109. #define UMSERR_OK                  0
  110. #define UMSERR_Unknown             1
  111.  
  112. #define UMSERR_CodeMissing       100
  113. #define UMSERR_ForbiddenCode     101
  114. #define UMSERR_NoWriteAccess     102
  115. #define UMSERR_NoReader          103
  116. #define UMSERR_NoExporter        104
  117. #define UMSERR_BadLink           105
  118. #define UMSERR_NoWork            106
  119. #define UMSERR_NoSysop           107
  120.  
  121. #define UMSERR_Dupe              200
  122. #define UMSERR_NoReadAccess      201
  123. #define UMSERR_NoViewAccess      202
  124. #define UMSERR_MsgCorrupted      203
  125. #define UMSERR_NoHdrSpace        204
  126. #define UMSERR_NoSuchMsg         205
  127. #define UMSERR_BadName           206
  128. #define UMSERR_BadTag            207
  129. #define UMSERR_MissingTag        208
  130. #define UMSERR_NoSuchUser        209
  131. #define UMSERR_NotFound          210
  132. #define UMSERR_AutoBounce        211
  133. #define UMSERR_MsgDeleted        212
  134. #define UMSERR_NoNetAccess       213
  135.  
  136. #define UMSERR_ServerTerminated  300
  137. #define UMSERR_CantWrite         301
  138. #define UMSERR_CantRead          302
  139. #define UMSERR_WrongMsgPtr       303
  140. #define UMSERR_ServerNotFree     304
  141. #define UMSERR_IDCountProb       305
  142. #define UMSERR_NoLogin           306
  143. #define UMSERR_WrongServer       307
  144.  
  145. /* tags */
  146. #define UMSTAG_String    0x2000
  147. #define UMSTAG_VarPar    0x4000
  148.  
  149. /* ReadUMSMsg() */
  150. #define UMSTAG_RMsgNum         (TAG_USER +                                   1)
  151. #define UMSTAG_RHeaderLength   (TAG_USER +                 UMSTAG_VarPar +   2)
  152. #define UMSTAG_RTextLength     (TAG_USER +                 UMSTAG_VarPar +   3)
  153. #define UMSTAG_RMsgDate        (TAG_USER +                 UMSTAG_VarPar +   4)
  154. #define UMSTAG_RChainUp        (TAG_USER +                 UMSTAG_VarPar +   7)
  155. #define UMSTAG_RChainDn        (TAG_USER +                 UMSTAG_VarPar +   8)
  156. #define UMSTAG_RChainLt        (TAG_USER +                 UMSTAG_VarPar +   9)
  157. #define UMSTAG_RChainRt        (TAG_USER +                 UMSTAG_VarPar +  10)
  158. #define UMSTAG_RGlobalFlags    (TAG_USER +                 UMSTAG_VarPar +  11)
  159. #define UMSTAG_RUserFlags      (TAG_USER +                 UMSTAG_VarPar +  12)
  160. #define UMSTAG_RLoginFlags     (TAG_USER +                 UMSTAG_VarPar +  13)
  161. #define UMSTAG_RHardLink       (TAG_USER +                 UMSTAG_VarPar +  14)
  162. #define UMSTAG_RSoftLink       (TAG_USER +                 UMSTAG_VarPar +  15)
  163. #define UMSTAG_RDateStyle      (TAG_USER +                                  64)
  164. #define UMSTAG_RIDStyle        (TAG_USER +                                  68)
  165. #define UMSTAG_RNoUpdate       (TAG_USER +                                  69)
  166. #define UMSTAG_RMsgText        (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 256)
  167. #define UMSTAG_RFromName       (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 257)
  168. #define UMSTAG_RFromPath       (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 258)
  169. #define UMSTAG_RToName         (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 259)
  170. #define UMSTAG_RToPath         (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 260)
  171. #define UMSTAG_RMsgID          (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 261)
  172. #define UMSTAG_RCreationDate   (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 262)
  173. #define UMSTAG_RReceiveDate    (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 263)
  174. #define UMSTAG_RReferID        (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 264)
  175. #define UMSTAG_RGroup          (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 265)
  176. #define UMSTAG_RSubject        (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 266)
  177. #define UMSTAG_RAttributes     (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 267)
  178. #define UMSTAG_RComments       (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 268)
  179. #define UMSTAG_ROrganization   (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 269)
  180. #define UMSTAG_RDistribution   (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 270)
  181. #define UMSTAG_RMsgInfo        (TAG_USER +                                 512)
  182. #define UMSTAG_RTextFields     (TAG_USER +                                 513)
  183. #define UMSTAG_RReadHeader     (TAG_USER +                                 514)
  184. #define UMSTAG_RReadAll        (TAG_USER +                                 515)
  185.  
  186. /* WriteUMSMsg() */
  187. #define UMSTAG_WMsgNum         (TAG_USER +                   1)
  188. #define UMSTAG_WMsgDate        (TAG_USER +                   4)
  189. #define UMSTAG_WChainUp        (TAG_USER +                   7)
  190. #define UMSTAG_WHardLink       (TAG_USER +                  14)
  191. #define UMSTAG_WSoftLink       (TAG_USER +                  15)
  192. #define UMSTAG_WAutoBounce     (TAG_USER +                  65)
  193. #define UMSTAG_WHdrFill        (TAG_USER +                  66)
  194. #define UMSTAG_WTxtFill        (TAG_USER +                  67)
  195. #define UMSTAG_WNoUpdate       (TAG_USER +                  69)
  196. #define UMSTAG_WMsgText        (TAG_USER + UMSTAG_String + 256)
  197. #define UMSTAG_WFromName       (TAG_USER + UMSTAG_String + 257)
  198. #define UMSTAG_WFromPath       (TAG_USER + UMSTAG_String + 258)
  199. #define UMSTAG_WToName         (TAG_USER + UMSTAG_String + 259)
  200. #define UMSTAG_WToPath         (TAG_USER + UMSTAG_String + 260)
  201. #define UMSTAG_WMsgID          (TAG_USER + UMSTAG_String + 261)
  202. #define UMSTAG_WCreationDate   (TAG_USER + UMSTAG_String + 262)
  203. #define UMSTAG_WReceiveDate    (TAG_USER + UMSTAG_String + 263)
  204. #define UMSTAG_WReferID        (TAG_USER + UMSTAG_String + 264)
  205. #define UMSTAG_WGroup          (TAG_USER + UMSTAG_String + 265)
  206. #define UMSTAG_WSubject        (TAG_USER + UMSTAG_String + 266)
  207. #define UMSTAG_WAttributes     (TAG_USER + UMSTAG_String + 267)
  208. #define UMSTAG_WComments       (TAG_USER + UMSTAG_String + 268)
  209. #define UMSTAG_WOrganization   (TAG_USER + UMSTAG_String + 269)
  210. #define UMSTAG_WDistribution   (TAG_USER + UMSTAG_String + 270)
  211.  
  212. /* UMSSelect() */
  213. #define UMSTAG_SelSet          (TAG_USER +                 1024)
  214. #define UMSTAG_SelUnset        (TAG_USER +                 1025)
  215. #define UMSTAG_SelWriteGlobal  (TAG_USER +                 1026)
  216. #define UMSTAG_SelWriteLocal   (TAG_USER +                 1027)
  217. #define UMSTAG_SelWriteUser    (TAG_USER + UMSTAG_String + 1028)
  218. #define UMSTAG_SelStart        (TAG_USER +                 1032)
  219. #define UMSTAG_SelStop         (TAG_USER +                 1033)
  220. #define UMSTAG_SelReadGlobal   (TAG_USER +                 1034)
  221. #define UMSTAG_SelReadLocal    (TAG_USER +                 1035)
  222. #define UMSTAG_SelReadUser     (TAG_USER + UMSTAG_String + 1036)
  223. #define UMSTAG_SelMask         (TAG_USER +                 1040)
  224. #define UMSTAG_SelMatch        (TAG_USER +                 1041)
  225. #define UMSTAG_SelParent       (TAG_USER +                 1042)
  226. #define UMSTAG_SelDate         (TAG_USER +                 1043)
  227. #define UMSTAG_SelTree         (TAG_USER +                 1044)
  228. #define UMSTAG_SelSubTree      (TAG_USER +                 1045)
  229. #define UMSTAG_SelMsg          (TAG_USER +                 1046)
  230. #define UMSTAG_SelQuick        (TAG_USER +                 1047)
  231.  
  232. /* UMSSearch() */
  233. #define UMSTAG_SearchLast      (TAG_USER +               + 2048)
  234. #define UMSTAG_SearchQuick     (TAG_USER +               + 2049)
  235. #define UMSTAG_SearchGlobal    (TAG_USER +               + 2050)
  236. #define UMSTAG_SearchLocal     (TAG_USER +               + 2051)
  237. #define UMSTAG_SearchUser      (TAG_USER + UMSTAG_String + 2052)
  238. #define UMSTAG_SearchDirection (TAG_USER +               + 2053)
  239. #define UMSTAG_SearchMask      (TAG_USER +               + 2064)
  240. #define UMSTAG_SearchMatch     (TAG_USER +               + 2065)
  241.  
  242. /* ReadUMSConfig(), WriteUMSConfig() */
  243. #define UMSTAG_CfgGlobalOnly   (TAG_USER +               + 3072)
  244. #define UMSTAG_CfgStringName   (TAG_USER + UMSTAG_String + 3073)
  245. #define UMSTAG_CfgUser         (TAG_USER + UMSTAG_String + 3074)
  246.  
  247. /* ReadUMSConfig() */
  248. #define UMSTAG_CfgUserName     (TAG_USER + UMSTAG_String + 3075)
  249.  
  250. /* not yet implemented :
  251. #define UMSTAG_CfgMatchPattern (TAG_USER                 + 3076)
  252. #define UMSTAG_CfgSameNetgroup (TAG_USER + UMSTAG_String + 3077)
  253. #define UMSTAG_CfgNextAka      (TAG_USER + UMSTAG_String + 3078)
  254. #define UMSTAG_CfgNextNetgroup (TAG_USER + UMSTAG_String + 3079)
  255. #define UMSTAG_CfgNextUser     (TAG_USER + UMSTAG_String + 3080)
  256. #define UMSTAG_CfgNextAlias    (TAG_USER + UMSTAG_String + 3081)
  257. #define UMSTAG_CfgNextString   (TAG_USER + UMSTAG_String + 3082)
  258. */
  259.  
  260. /* WriteUMSConfig() */
  261. #define UMSTAG_CfgDump         (TAG_USER + UMSTAG_String + 3088)
  262. #define UMSTAG_CfgStringData   (TAG_USER + UMSTAG_String + 3089)
  263.  
  264. #endif
  265.